<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/hardware/rtc.h File Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('rp2__common_2hardware__rtc_2include_2hardware_2rtc_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">rtc.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
<code>#include &quot;hardware/structs/rtc.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for rtc.h:</div>
<div class="dyncontent">
<div class="center"><img src="rp2__common_2hardware__rtc_2include_2hardware_2rtc_8h__incl.png" border="0" usemap="#ainclude_2hardware_2rtc_8h" alt=""/></div>
<map name="ainclude_2hardware_2rtc_8h" id="ainclude_2hardware_2rtc_8h">
<area shape="rect" title=" " alt="" coords="667,5,833,32"/>
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="649,229,710,256"/>
<area shape="rect" href="rp2040_2hardware__structs_2include_2hardware_2structs_2rtc_8h_source.html" title=" " alt="" coords="740,80,904,107"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,453,259,480"/>
<area shape="rect" title=" " alt="" coords="420,304,533,331"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="558,304,662,331"/>
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="687,304,808,331"/>
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="832,304,927,331"/>
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,528,111,555"/>
<area shape="rect" title=" " alt="" coords="74,603,157,629"/>
<area shape="rect" title=" " alt="" coords="211,528,281,555"/>
<area shape="rect" title=" " alt="" coords="306,528,381,555"/>
<area shape="rect" title=" " alt="" coords="173,379,337,405"/>
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,379,543,405"/>
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,379,746,405"/>
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,379,930,405"/>
<area shape="rect" title=" " alt="" coords="1130,379,1341,405"/>
<area shape="rect" title=" " alt="" coords="955,379,1105,405"/>
<area shape="rect" title=" " alt="" coords="357,453,548,480"/>
<area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="717,155,927,181"/>
<area shape="rect" title=" " alt="" coords="951,155,1099,181"/>
</map>
</div>
</div>
<p><a href="rp2__common_2hardware__rtc_2include_2hardware_2rtc_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga05a9e12c70c56e6e2a9869d0682045d1"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a>) (void)</td></tr>
<tr class="separator:ga05a9e12c70c56e6e2a9869d0682045d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacf9024748b942a7ae375cf75951afa9c"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_init</b> (void)</td></tr>
<tr class="memdesc:gacf9024748b942a7ae375cf75951afa9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the RTC system. <br /></td></tr>
<tr class="separator:gacf9024748b942a7ae375cf75951afa9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga076d68dec35129dd2b44d16ae457a3de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">rtc_set_datetime</a> (const <a class="el" href="structdatetime__t.html">datetime_t</a> *t)</td></tr>
<tr class="memdesc:ga076d68dec35129dd2b44d16ae457a3de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the RTC to the specified time.  <a href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">More...</a><br /></td></tr>
<tr class="separator:ga076d68dec35129dd2b44d16ae457a3de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">rtc_get_datetime</a> (<a class="el" href="structdatetime__t.html">datetime_t</a> *t)</td></tr>
<tr class="memdesc:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current time from the RTC.  <a href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">More...</a><br /></td></tr>
<tr class="separator:ga7c5528e71733b7bfc0b0543cd3bb6d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="memItemLeft" align="right" valign="top">
bool&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_running</b> (void)</td></tr>
<tr class="memdesc:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the RTC running? <br /></td></tr>
<tr class="separator:gabf6cc1546be8d1ddb56e3d83a915f683"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac8ad85f301295b6a130aa8e00122253"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">rtc_set_alarm</a> (const <a class="el" href="structdatetime__t.html">datetime_t</a> *t, <a class="el" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a> user_callback)</td></tr>
<tr class="memdesc:gaac8ad85f301295b6a130aa8e00122253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a time in the future for the RTC to call a user provided callback.  <a href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">More...</a><br /></td></tr>
<tr class="separator:gaac8ad85f301295b6a130aa8e00122253"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7f69ee0de1cae2518b2822fd82d5201"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_enable_alarm</b> (void)</td></tr>
<tr class="memdesc:gab7f69ee0de1cae2518b2822fd82d5201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the RTC alarm (if inactive) <br /></td></tr>
<tr class="separator:gab7f69ee0de1cae2518b2822fd82d5201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga718b866eab2ba73221d37f7d15ba9737"><td class="memItemLeft" align="right" valign="top">
void&#160;</td><td class="memItemRight" valign="bottom"><b>rtc_disable_alarm</b> (void)</td></tr>
<tr class="memdesc:ga718b866eab2ba73221d37f7d15ba9737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the RTC alarm (if active) <br /></td></tr>
<tr class="separator:ga718b866eab2ba73221d37f7d15ba9737"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>